/*!
 * # 模块 Api 类:
 *  Creating - 新通知
 * 
 * # 描述:
 *  提供用户创建和发送通知的功能。
 *  
 *  Copyright (c), 上海沃恩信息科技有限公司.
 *  All rights reserved.
 *  Licensed under BSD (https://www.pittypat.work/bsd.html).
 */

using System;
using System.Collections.Generic;
using System.Linq;
using System.Threading.Tasks;
using Pittypat;

namespace Waln.Notifying.Creating
{
	/// <summary>
	/// 提供对模块 新通知 中功能的封装和调用。
	/// </summary>
	[global::Pittypat.Module(global::Pittypat.ModulePresentation.UI, AllowAnonymous = false)]
	public sealed class Api : global::Pittypat.Module
	{
		#region SendAsync

		/// <summary>
		/// 向指定的接收人列表发送一条通知消息。
		/// </summary>
		/// <param name="model">功能模型对象，其中包含了功能的参数列表、执行状态以及相关消息。</param>
		/// <param name="progress">跟踪和汇报异步操作的进度。</param>
		/// <returns>操作成功返回 通知消息数目，否则返回 null。</returns>
		public async global::System.Threading.Tasks.Task<global::Pittypat.IJson> SendAsync(
			global::Pittypat.FunctionModel<Args.Send> model, 
			global::Pittypat.IAsyncProgress progress)
		{
			// 执行数据操作
			await this.DataService.Exec(model, progress);

			// 如果操作成功，返回通知消息数目
			return model.Success ? model.Args.NotificationCount : null;
		}

		#endregion

		#region UploadAsync

		/// <summary>
		/// 上传一个通知消息的附件文件。
		/// </summary>
		/// <param name="model">功能模型对象，其中包含了功能的参数列表、执行状态以及相关消息。</param>
		/// <param name="progress">跟踪和汇报异步操作的进度。</param>
		/// <returns>操作成功返回 附件，否则返回 null。</returns>
		public async global::System.Threading.Tasks.Task<global::Pittypat.IJson> UploadAsync(
			global::Pittypat.FunctionModel<Args.Upload> model, 
			global::Pittypat.IAsyncProgress progress)
		{
			// 执行数据操作
			await this.DataService.Exec(model, progress);

            if (model.Success)
            {
                // 保存成功，返回路径信息
                return model.Args.Attachment;
            }
            else
            {
                // 保存失败，删除附件文件
                Pittypat.Web.VirtualFile.Delete(model.Args.Url);
                return null;
            }
		}

		#endregion

		#region DeleteAttachmentAsync

		/// <summary>
		/// 删除通知中包含的附件文件。
		/// </summary>
		/// <param name="model">功能模型对象，其中包含了功能的参数列表、执行状态以及相关消息。</param>
		/// <param name="progress">跟踪和汇报异步操作的进度。</param>
		/// <returns>操作成功返回 文件路径，否则返回 null。</returns>
		public async global::System.Threading.Tasks.Task<global::Pittypat.IJson> DeleteAttachmentAsync(
			global::Pittypat.FunctionModel<Args.DeleteAttachment> model, 
			global::Pittypat.IAsyncProgress progress)
		{
			// 执行数据操作
			await this.DataService.Exec(model, progress);

            if (!model.Args.Url.IsNullOrEmpty())
            {
                // 删除虚拟路径对应的物理文件
                global::Pittypat.Web.VirtualFile.Delete(model.Args.Url);
            }

            // model 没有定义输出参数，返回操作的结果消息
            return null;
        }

		#endregion

		#region ReceiversAsync

		/// <summary>
		/// 查询当前用户的可用所有接收人的列表。用于在发送通知消息时选择接收人。
		/// </summary>
		/// <param name="model">功能模型对象，其中包含了功能的参数列表、执行状态以及相关消息。</param>
		/// <param name="progress">跟踪和汇报异步操作的进度。</param>
		/// <returns>操作成功返回 接收人列表，否则返回 null。</returns>
		public async global::System.Threading.Tasks.Task<global::Pittypat.IJson> ReceiversAsync(
			global::Pittypat.FunctionModel<Args.Receivers> model, 
			global::Pittypat.IAsyncProgress progress)
        {
            // 执行数据操作
            await this.DataService.Exec(model, progress);

            // 如果操作成功，返回所有输出参数的字典
            return model.Success ? model.OutArgs : null;
        }

		#endregion
	}
}
